TYP: enable reportPropertyTypeMismatch #43853
Conversation
pandas/core/generic.py
Outdated
| @@ -340,7 +340,7 @@ def attrs(self) -> dict[Hashable, Any]: | |||
| return self._attrs | |||
|
|
|||
| @attrs.setter | |||
| def attrs(self, value: Mapping[Hashable, Any]) -> None: | |||
| def attrs(self, value: dict[Hashable, Any]) -> None: | |||
| self._attrs = dict(value) | |||
There was a problem hiding this comment.
shouldn't you leave the input annotation and then this is equiv of a cast? we do this in lots of places. why is this flagged?
There was a problem hiding this comment.
This is not a typing issue, If I understand it correctly, pyright flags this because the property is meant to act like a variable, which means that setting and getting the value of the variable should have the same type.
Pyright doesn't like the following (independent of the function body):
@property
def attrs(self) -> dict[Hashable, Any]:
...
@attrs.setter
def attrs(self, value: Mapping[Hashable, Any]) -> None:
...Both should be a Mapping or both should be a dict.
I can see why pyright wants to encourage using property like a variable, but I'm also happy to close this PR if this is too controversial/not intended.
|
This looks like a case where 1) pyright is technically incorrect (passing a non-dict Mapping looks benign) and 2) its not that big a deal (if using "dict" will allow us to enable pyright in a way that will prevent bugs, then its fine) |
|
I think the three options are:
I'm slightly inclined to 1 as it seems to be a deliberate choice to support setting any dict-like object. |
|
I updated the PR to not change the type annotation, but instead add a pyright-ignore comment. |
This might be controversial. The setter allows any
Mappingbut the getter returns adict.reportPropertyTypeMismatch: